<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ADIN1110 Device Driver API Reference Manual: adi_eth_BufDesc_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">ADIN1110 Device Driver API Reference Manual
   &#160;<span id="projectnumber">1.1.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('structadi__eth___buf_desc__t.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structadi__eth___buf_desc__t-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">adi_eth_BufDesc_t Struct Reference<div class="ingroups"><a class="el" href="group__mac.html">MAC Definitions</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Buffer descriptor for Tx/Rx.  
 <a href="structadi__eth___buf_desc__t.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="adi__mac_8h_source.html">adi_mac.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:af20e64d32db773e418fbd3a5d970f95b"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structadi__eth___buf_desc__t.html#af20e64d32db773e418fbd3a5d970f95b">pBuf</a></td></tr>
<tr class="separator:af20e64d32db773e418fbd3a5d970f95b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3b95b07a548b9a7893d4596b28ca7ee"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structadi__eth___buf_desc__t.html#af3b95b07a548b9a7893d4596b28ca7ee">bufSize</a></td></tr>
<tr class="separator:af3b95b07a548b9a7893d4596b28ca7ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a24715ce826bd7c9f817231b1e8515d0b"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structadi__eth___buf_desc__t.html#a24715ce826bd7c9f817231b1e8515d0b">trxSize</a></td></tr>
<tr class="separator:a24715ce826bd7c9f817231b1e8515d0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20466e33c41ef739e6613782d826bc81"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__adi__eth__common.html#ga51d48e6c00ceda8e49df55a6e3227f59">adi_eth_Callback_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structadi__eth___buf_desc__t.html#a20466e33c41ef739e6613782d826bc81">cbFunc</a></td></tr>
<tr class="separator:a20466e33c41ef739e6613782d826bc81"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a46a9d580736db8b0398c053c12fd1ead"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__mac.html#ga00cc8a8b829d6251008d793be4ea5ce7">adi_mac_RxFifoPrio_e</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structadi__eth___buf_desc__t.html#a46a9d580736db8b0398c053c12fd1ead">prio</a></td></tr>
<tr class="separator:a46a9d580736db8b0398c053c12fd1ead"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6f38f89d9980c8dc83adec0859139f1"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structadi__eth___buf_desc__t.html#aa6f38f89d9980c8dc83adec0859139f1">rsvd</a></td></tr>
<tr class="separator:aa6f38f89d9980c8dc83adec0859139f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3c2e9a93e2ce027bf88f31214196228"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__mac.html#ga9fe6bdd6bd80b35aba6334779ad340f0">adi_mac_EgressCapture_e</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structadi__eth___buf_desc__t.html#ae3c2e9a93e2ce027bf88f31214196228">egressCapt</a></td></tr>
<tr class="separator:ae3c2e9a93e2ce027bf88f31214196228"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaacd41f036fbf5ad187da4679a873e86"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structadi__eth___buf_desc__t.html#aaacd41f036fbf5ad187da4679a873e86">timestampValid</a></td></tr>
<tr class="separator:aaacd41f036fbf5ad187da4679a873e86"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a9389bc82dc449217a0867ef3daefe0"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structadi__eth___buf_desc__t.html#a0a9389bc82dc449217a0867ef3daefe0">timestamp</a></td></tr>
<tr class="separator:a0a9389bc82dc449217a0867ef3daefe0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf2c4999522ac40afad25344eb16f8c9"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structadi__eth___buf_desc__t.html#acf2c4999522ac40afad25344eb16f8c9">timestampExt</a></td></tr>
<tr class="separator:acf2c4999522ac40afad25344eb16f8c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f371d807e2a3c8d2772e4935556ac02"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structadi__eth___buf_desc__t.html#a3f371d807e2a3c8d2772e4935556ac02">refCount</a></td></tr>
<tr class="separator:a3f371d807e2a3c8d2772e4935556ac02"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Buffer descriptor for Tx/Rx. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="af3b95b07a548b9a7893d4596b28ca7ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af3b95b07a548b9a7893d4596b28ca7ee">&#9670;&nbsp;</a></span>bufSize</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t adi_eth_BufDesc_t::bufSize</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Buffer size in bytes, used to check for overflows in Rx. <br  />
 </p>

</div>
</div>
<a id="a20466e33c41ef739e6613782d826bc81"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20466e33c41ef739e6613782d826bc81">&#9670;&nbsp;</a></span>cbFunc</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__adi__eth__common.html#ga51d48e6c00ceda8e49df55a6e3227f59">adi_eth_Callback_t</a> adi_eth_BufDesc_t::cbFunc</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Callback function. Called after the buffer was written to the Tx FIFO in transmit or read from Rx FIFO on receive. <br  />
 </p>

</div>
</div>
<a id="ae3c2e9a93e2ce027bf88f31214196228"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3c2e9a93e2ce027bf88f31214196228">&#9670;&nbsp;</a></span>egressCapt</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__mac.html#ga9fe6bdd6bd80b35aba6334779ad340f0">adi_mac_EgressCapture_e</a> adi_eth_BufDesc_t::egressCapt</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Configure capture of the egress timestamp. <br  />
 </p>

</div>
</div>
<a id="af20e64d32db773e418fbd3a5d970f95b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af20e64d32db773e418fbd3a5d970f95b">&#9670;&nbsp;</a></span>pBuf</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t* adi_eth_BufDesc_t::pBuf</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Pointer to the frame buffer for Tx or Rx. <br  />
 </p>

</div>
</div>
<a id="a46a9d580736db8b0398c053c12fd1ead"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46a9d580736db8b0398c053c12fd1ead">&#9670;&nbsp;</a></span>prio</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__mac.html#ga00cc8a8b829d6251008d793be4ea5ce7">adi_mac_RxFifoPrio_e</a> adi_eth_BufDesc_t::prio</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Indicates the Rx FIFO priority the frame was read from. <br  />
 </p>

</div>
</div>
<a id="a3f371d807e2a3c8d2772e4935556ac02"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f371d807e2a3c8d2772e4935556ac02">&#9670;&nbsp;</a></span>refCount</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t adi_eth_BufDesc_t::refCount</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Reference counter, indicates if a descriptor needs to be sent more than once. <br  />
 </p>

</div>
</div>
<a id="aa6f38f89d9980c8dc83adec0859139f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6f38f89d9980c8dc83adec0859139f1">&#9670;&nbsp;</a></span>rsvd</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t adi_eth_BufDesc_t::rsvd</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Reserved. <br  />
 </p>

</div>
</div>
<a id="a0a9389bc82dc449217a0867ef3daefe0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0a9389bc82dc449217a0867ef3daefe0">&#9670;&nbsp;</a></span>timestamp</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t adi_eth_BufDesc_t::timestamp</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Ingress timestamp received from the MAC. <br  />
 </p>

</div>
</div>
<a id="acf2c4999522ac40afad25344eb16f8c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf2c4999522ac40afad25344eb16f8c9">&#9670;&nbsp;</a></span>timestampExt</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t adi_eth_BufDesc_t::timestampExt</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Extended storage for 64b ingress timestamp. <br  />
 </p>

</div>
</div>
<a id="aaacd41f036fbf5ad187da4679a873e86"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaacd41f036fbf5ad187da4679a873e86">&#9670;&nbsp;</a></span>timestampValid</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool adi_eth_BufDesc_t::timestampValid</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Indicates if the timestamp field is valid. <br  />
 </p>

</div>
</div>
<a id="a24715ce826bd7c9f817231b1e8515d0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a24715ce826bd7c9f817231b1e8515d0b">&#9670;&nbsp;</a></span>trxSize</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t adi_eth_BufDesc_t::trxSize</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Frame size (Tx or Rx), in bytes. <br  />
 </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>C:/JenkinsSlaveIPNSW/workspace/10spe-drv_release_adin1110-1.1.0/inc/<a class="el" href="adi__mac_8h_source.html">adi_mac.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="structadi__eth___buf_desc__t.html">adi_eth_BufDesc_t</a></li>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
  </ul>
</div>
</body>
</html>
